Provision Customer End User

This request updates the details of the M365 customer tenant user including assigning numbers and configuring Calling policies. Once a number is assigned, its updated to both Live Platform and Teams admin center.

●

This functionality is only supported for OC Essentials Plus and OC Pro customers; ensure you have a secure Token connection for synchronization between Live Platform and Microsoft Teams.

●

For OC Essentials customers, users must be managed directly in their Teams admin center.

URI

Copy

{{baseUrl}}/api/v2/customer/b2c6bc2f-f42a-4cd2-b253-143764d7c2ec/user/sip:Christiec@M365x43868129.onmicrosoft.com/script

HTTP Method

PUT

Request Parameters

Parameter	Type	Description
umpcustomerGuid	string($uuid) (path)	Live Platform generated customer Id. Search for this value by searching for the customer name using Get Services Brief Details (V3).

Request Body

Parameter	Type	Description
FirstName	string
Last Name	string
City	string
Department	string
Office	string
PostalCode	string
StateOrProvince	string
StreetAddress	string
UsageLocation	integer	A valid ISO 3166-1 alpha-2 country code. (e.g., US for the United States, and FR for France)
ClientPolicy	string	Name of the policy to assign
ConferencingPolicy	string	Name of the policy to assign
HostedVoiceMail	Boolean	True or False
PinPolicy	string	Name of the policy to assign
ExternalAccessPolicy	string	Name of the policy to assign
HostedVoicemailPolicy	string	Name of the policy to assign
MobilityPolicy	string	Name of the policy to assign
EnterpriseVoiceEnabled	boolean	Enable Enterprise Voice for the user.
TeamsCallingPolicy	string	Assign Teams Calling policy. For example, 'AllowCalling' to user. For full list of values, LifeCycle Management Templates.
OnlineVoiceRoutingPolicy	string	Assign Online Voice Routing policy to user .Default 'unrestricted'
DialPlan	string	DialPlan Name of the dial plan to assign
LineURI	string	Telephone number in E164 format preceded by Tel to assign to user. For example, "Tel:+442024938000".
PrivateLine	string	Telephone number in E164 format preceded by Tel to assign to user. For example, "Tel:+442024938000".
CallPickupGroup	string	Call pickup group number like #409.
GroupingId GUID	string	For example "ad4376fb-ca3a-418a-ba2ab848442af2b4".

The 'Usage location' of the user must match the phone number country code. The Usage Location must be manually set in the customer Teams admin center. See Set Usage Location.

Example Request

Copy

{
"TeamsCallingPolicy": "AllowCalling",    
"EnterpriseVoiceEnabled": true,    
"LineURI": "tel:+61398675580"
}

Example Response

Copy

{
    "Identity": "fba6114b-5cc4-4346-877d-286329a626e1",
    "Status": "----",
    "CallForward": "",
    "Department": null,
    "WebName": "Christie Cline",
    "LineURI": "tel:+61398675580",
    "UserType": "TeamsOnly",
    "MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
    "SipAddress": "sip:christiec@m365x43868129.onmicrosoft.com",
    "UsageLocation": "AU",
    "HybridPstnSiteName": null,
    "RegistrarPool": null,
    "ObjectId": "FBA6114B-5CC4-4346-877D-286329A626E1",
    "PsCount": 4,
    "IsManaged": true,
    "HostingProvider": "sipfed.online.lync.com",
    "EnterpriseVoiceEnabled": true,
    "OnlineVoiceRoutingPolicy": "",
    "Template": null
}

The assigned number is displayed in the customer Teams admin center.

Response

■

200 OK

Parameter	Type	Description
Identity	string($uuid) (path)	Live Platform generated customer 'umpcustomerGuid'.
Status	string	??
CallForward	boolean	Indicates whether Call Forwarding is enabled for the user.
Department	string	Active Directory User department.
WebName	string	Name of the M365 customer tenant user.
LineURI	string	Line URI assigned to user.
UserType	string	Default: TeamsOnly
MsInterpretedUserType	string	Default: PureOnlineTeamsOnlyUser
SipAddress	string	M365 user SIP address. For example, sip:christiec@m365x43868129.onmicrosoft.com
UsageLocation	string	Usage Location as defined in the customer tenant Microsoft Entra admin center (see Set Usage Location).
HybridPstnSiteName	string	??
RegistrarPool	string	??
ObjectId	string	??
PsCount	integer	??
IsManaged	boolean	??
HostingProvider	string	sipfed.online.lync.com ???
EnterpriseVoiceEnabled	boolean	Indicates whether Enterprise Voice is enabled.
OnlineVoiceRoutingPolicy	string	Default: unrestricted or SiteLocationTag-Unrestricted
Template	string	Name of the LifeCycle Management template